Feat: Create / Add Axios Large Response Interceptor #5

alexmarqs · 2025-02-28T10:18:55Z

An Axios interceptor designed to handle large responses.

Global and per-request options;
Custom callback function to fetch large payloads from a reference data, customisable reference property names, headers, and other options;

- Add comprehensive types for interceptor configuration - Implement utility functions for large payload fetching - Update interceptor to support dynamic configuration - Add debug logging and error handling - Expose new export for types and interceptor function

- Rename types and functions for clarity - Add `enabled` option to conditionally apply interceptor - Support custom large payload fetching strategy - Update namespace and default options - Enhance type safety and configuration flexibility

- Create comprehensive test cases for axios large response interceptor - Add test configuration for Vitest - Implement initial test scenarios for request and response interceptors - Verify basic functionality and configuration options

- Add comprehensive test cases for global and custom configuration scenarios - Verify interceptor behavior with different response types - Improve test coverage for request and response interceptors - Enhance test suite with more detailed assertions

- Add test cases for per-request and global option configurations - Verify interceptor behavior with custom header flags and ref properties - Improve test suite with more nuanced option merging and handling scenarios - Expand assertions for large response interceptor functionality

…interceptor

…ceptor

…p new release version

…ption

jpinho · 2025-03-04T13:04:55Z

Hey @alexmarqs, I have a fundamental request here, can we switch to not send large response accepts by default?

By default, it assumes that your backend uses @epilot/large-response-middleware

I think it should be the other way around. By default it should fail, it's not ok to have APIs return over 6MB of data, demonstrates likely a bad design in the code.

Would be nice for teams to inspect the failure and then decide to make it enabled:true. We should not have to do this (should be the default):

  axiosLargeResponse(client, {
    enabled: false,
    logger: Log,
  });

alexmarqs · 2025-03-04T13:13:30Z

Hey @alexmarqs, I have a fundamental request here, can we switch to not send large response accepts by default?

By default, it assumes that your backend uses @epilot/large-response-middleware

I think it should be the other way around. By default it should fail, it's not ok to have APIs return over 6MB of data, demonstrates likely a bad design in the code.

Would be nice for teams to inspect the failure and then decide to make it enabled:true. We should not have to do this (should be the default):
  axiosLargeResponse(client, {
    enabled: false,
    logger: Log,
  });

Hey @jpinho I totally get your point, I thought about that when designing this but ended up with the default being enabled. Happy to have your feedback here and I will change this based on that 🙂!

jpinho · 2025-03-04T13:18:45Z

Hey @alexmarqs, I have a fundamental request here, can we switch to not send large response accepts by default?

By default, it assumes that your backend uses @epilot/large-response-middleware

I think it should be the other way around. By default it should fail, it's not ok to have APIs return over 6MB of data, demonstrates likely a bad design in the code.
Would be nice for teams to inspect the failure and then decide to make it enabled:true. We should not have to do this (should be the default):
  axiosLargeResponse(client, {
    enabled: false,
    logger: Log,
  });
Hey @jpinho I totally get your point, I thought about that when designing this but ended up with the default being enabled. Happy to have your feedback here and I will change this based on that 🙂!

Yep, that also crossed my mind. It's just that enabling this will bloat our browsers caches, and slow down our MFEs greatly => in a super easy way.

We should log a warning for large responses on the client and make it default:false so that the change is explicit. Otherwise a distracted developer may start using our clients and pulling large response without even realising. We want the engineers to deal with the failure first, and only then use this as a tool to temporarily mitigate if required. Often the solution is to fix the bad code pulling such large responses.

- Add `disableWarnings` option to control usage warnings - Change default `enabled` option to `false` - Implement usage warnings for unset interceptor configuration - Update types and documentation to reflect new default behavior - Enhance flexibility of interceptor configuration

alexmarqs · 2025-03-05T13:34:44Z

@jpinho I have committed some changes based on your feedback, here is: 0383366

Change default enabled option to `false
Add disableWarnings global option to control warnings
Implement warnings for unset interceptor configuration (no explicit enabled global option set)
Update types and documentation to reflect new default behaviour

If all good, I will create a new release and bump the version and then merge. If not, let's keep iterating on this!

packages/axios-large-response/README.md

Co-authored-by: João Pinho <jpe.pinho@gmail.com>

jpinho · 2025-03-06T16:56:21Z

packages/axios-large-response/src/utils/utils.ts

+    ...DEFAULT_OPTIONS,
+    ...globalOptions,
+    ...configRequestOptions,
+  } satisfies AxiosLargeResponseOptions;


jpinho

Awesome contribution @alexmarqs 👏👏👏 ❤️

alexmarqs added 17 commits February 10, 2025 18:06

chore: commit base structure for axios interceptor

e75ba57

test: configure Vitest to run silently by default again

8a9ffa6

test: update axios interceptor test assertions for header modification

dcdb73c

docs: add comprehensive README for axios large response interceptor

49e241b

feat: add per-request configuration support for axios large response …

a6d5a7b

…interceptor

chore: update package name and version for axios large response inter…

f67c070

…ceptor

feat: add error payload handling for large response interceptor + bum…

f85d705

…p new release version

chore: update package keywords and import statement in README

19bb476

docs: improve README with clearer description and add debug logging o…

4b391a6

…ption

docs: add axios large response interceptor reference to README

c15eca6

chore: improve README.md

29c2168

docs: update Axios Large Response link text in README

1feecec

alexmarqs requested a review from jpinho February 28, 2025 12:30

jpinho reviewed Mar 6, 2025

View reviewed changes

packages/axios-large-response/README.md Outdated Show resolved Hide resolved

Update packages/axios-large-response/README.md

4801ccd

Co-authored-by: João Pinho <jpe.pinho@gmail.com>

jpinho reviewed Mar 6, 2025

View reviewed changes

jpinho approved these changes Mar 6, 2025

View reviewed changes

chore: bump package version to 0.0.2

201f5e2

alexmarqs merged commit 78b87b7 into epilot-dev:main Mar 6, 2025
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Feat: Create / Add Axios Large Response Interceptor #5

Feat: Create / Add Axios Large Response Interceptor #5

Uh oh!

alexmarqs commented Feb 28, 2025

Uh oh!

jpinho commented Mar 4, 2025 •

edited

Loading

Uh oh!

alexmarqs commented Mar 4, 2025 •

edited

Loading

Uh oh!

jpinho commented Mar 4, 2025 •

edited

Loading

Uh oh!

alexmarqs commented Mar 5, 2025

Uh oh!

Uh oh!

jpinho Mar 6, 2025

Uh oh!

jpinho left a comment •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Feat: Create / Add Axios Large Response Interceptor #5

Feat: Create / Add Axios Large Response Interceptor #5

Uh oh!

Conversation

alexmarqs commented Feb 28, 2025

Uh oh!

jpinho commented Mar 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alexmarqs commented Mar 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jpinho commented Mar 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alexmarqs commented Mar 5, 2025

Uh oh!

Uh oh!

jpinho Mar 6, 2025

Choose a reason for hiding this comment

Uh oh!

jpinho left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jpinho commented Mar 4, 2025 •

edited

Loading

alexmarqs commented Mar 4, 2025 •

edited

Loading

jpinho commented Mar 4, 2025 •

edited

Loading

jpinho left a comment •

edited

Loading